Repository navigation
docs: state the framework-page contract per integration tier - #695
Merged
Merged
Conversation
The old sentence claimed every framework integration exposes evlog(), useLogger() and log.fork(). The source contradicts it: fork is wired only via defineFrameworkIntegration (elysia, express, fastify, hono, nestjs, next, orpc, react-router, sveltekit, workers), nuxt and nitro are event-bound with no fork, and astro, aws-lambda and standalone are guide-level on the core createLogger/createRequestLogger API. A reviewer applying the old line literally would flag correct pages as incomplete.
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
|
Thank you for following the naming conventions! 🙏 |
commit: |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The framework-page standard in
.agents/skills/write-evlog-content/references/surfaces/docs.mdclaimed every framework integration exposesevlog(),useLogger(),log.fork()and the fullBaseEvlogOptionssurface. The package source contradicts that, so a reviewer applying the line literally flags correct pages as incomplete and a rewriter would document APIs that do not exist. The section is rewritten as a per-tier contract:defineFrameworkIntegrationtake the fullBaseEvlogOptionssurface and a request-bound logger, with the accessor names per entry point listed exactly:evlog()(elysia, express, fastify, hono, react-router, sveltekit),evlog()andwithEvlog()(orpc),createEvlog()/evlogMiddleware()(next),EvlogModule(nestjs),withEvlog()/createWorkersLogger()(workers).log.fork()is wired only where request scope isAsyncLocalStorage-backed: nine of the ten, workers excepted because it must stay free ofnode:async_hooks.useLogger(event), nolog.fork().initLogger/createLogger/createRequestLoggerAPI; their pages must not gainevlog(),useLogger()orlog.fork().evlog/workersdelivers the logger as the handler's fourth argument.Evidence (verified against
main, a82f2b4)defineFrameworkIntegrationappears in exactly those ten packages underpackages/evlog/src.attachForkToLoggerfires onlyif (spec.storage)(src/shared/integration.ts), and the workers spec sets none (src/workers/index.ts:146).evlog()export locations: elysia:122, express:55, fastify:102, hono:99, orpc:183, react-router:64, sveltekit:155.withEvlog(): orpc:110, workers:198. next exportscreateEvlog:43,evlogMiddleware:9. nestjs exportsEvlogModule:93.useLoggeris exported fromsrc/runtime/server/useLogger.ts(event-bound) and re-exported by every tier-one entry point except workers.src/logger.ts:855: standalone loggers have nofork;14.astro.md,16.aws-lambda.mdand13.standalone.mddocument the core API.04.nitro.mdstatinglog.fork()is not available.Verification
pnpm content:linton the edited file at the final revision: dashes 0, epigram ratio 0, sentence CV 0.5. The two T-15 hits at line 52 are pre-existing false positives on the bullet that deliberately bansevlog/sharedandevlog/browser.evlog()is not exported by next, nestjs or workers, and workers gets no fork. Round 2 caught orpc's publicwithEvlog()missing from the mapping. Round 3: pass, no critical or standard findings.pnpm run lint22/22,pnpm run typecheck27/27,pnpm run testall suites green (evlog 90 files / 1899 tests, docs 7/139, telemetry 5/57, among others).Notes
.agents/skills/, not a consumer-facing package change.skills/mirror does not contain this file; only the internal.agents/skills/copy exists.Closes EVL-361 (2026-08-28 content pass, enrich half).